Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates #1384

Merged
merged 3 commits into from
Apr 26, 2023
Merged

Doc updates #1384

merged 3 commits into from
Apr 26, 2023

Conversation

tkatila
Copy link
Contributor

@tkatila tkatila commented Apr 18, 2023

Updates for documentation from #1045.

Fixes: #1381
Fixes: #1132
Fixes: #1059

@codecov-commenter
Copy link

codecov-commenter commented Apr 18, 2023

Codecov Report

Merging #1384 (cc716b7) into main (3744e09) will not change coverage.
The diff coverage is n/a.

❗ Current head cc716b7 differs from pull request most recent head 8971280. Consider uploading reports for the commit 8971280 to get more accurate results

@@           Coverage Diff           @@
##             main    #1384   +/-   ##
=======================================
  Coverage   50.89%   50.89%           
=======================================
  Files          44       44           
  Lines        4985     4985           
=======================================
  Hits         2537     2537           
  Misses       2302     2302           
  Partials      146      146           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mythi
Copy link
Contributor

mythi commented Apr 18, 2023

Updates for documentation from #1045.

Addresses: #1381 Addresses: #1132 Addresses: #1059

small nit: Addresses is not a recognized keyword.

Copy link
Contributor

@eero-t eero-t left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good in general, main thing is moving "Use Cases for Different Modes" to where the related CLI options are documented.

cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/operator/README.md Outdated Show resolved Hide resolved
cmd/operator/README.md Outdated Show resolved Hide resolved
@eero-t
Copy link
Contributor

eero-t commented Apr 19, 2023

"Fixes:" syntax differs between commits, in one the issue number is missing '#'.

cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
@eero-t
Copy link
Contributor

eero-t commented Apr 19, 2023

I think this is fine for merging (with or without the last trivial fine-tuning comments to my earlier suggestions).

cmd/operator/README.md Outdated Show resolved Hide resolved
cmd/operator/README.md Show resolved Hide resolved
@tkatila tkatila force-pushed the doc-updates branch 2 times, most recently from 69c9fe3 to a2db2e3 Compare April 24, 2023 06:52
tkatila and others added 2 commits April 24, 2023 09:52
Fixes: intel#1132

Co-authored-by: Eero Tamminen <[email protected]>
Signed-off-by: Tuomas Katila <[email protected]>
mythi
mythi previously approved these changes Apr 26, 2023
Copy link
Contributor

@mythi mythi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@uniemimu to merge

cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
mythi
mythi previously approved these changes Apr 26, 2023
cmd/gpu_plugin/README.md Outdated Show resolved Hide resolved
Fixes: intel#1381

Co-authored-by: Eero Tamminen <[email protected]>
Signed-off-by: Tuomas Katila <[email protected]>
Copy link
Member

@bart0sh bart0sh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@mythi mythi merged commit e56e0e6 into intel:main Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants